<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArMapInfoInterface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArMapInfoInterface.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classArMapInfoInterface-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArMapInfoInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Methods related to setting and retrieving the various "info" tags in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map.  
 <a href="classArMapInfoInterface.html#details">More...</a></p>

<p><code>#include &lt;ArMapInterface.h&gt;</code></p>

<p>Inherited by <a class="el" href="classArMapInfo.html">ArMapInfo</a>, and <a class="el" href="classArMapInterface.html">ArMapInterface</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a9acc582d92ba2e4748a21c74bd298ac9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="classArMapInfoInterface.html#a9acc582d92ba2e4748a21c74bd298ac9a20ee240af44438cad2f33cfe29f21b23">INFO_COUNT</a> = LAST_INFO + 1
 }</td></tr>
<tr class="separator:a9acc582d92ba2e4748a21c74bd298ac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8f1a9d7cce478985fc30c9237d93e05"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05">InfoType</a> { <br />
&#160;&#160;<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a34eb25df5af2b80fc9da559b7074b2a7">MAP_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a43cc914ec328dc61f7ad3ac3c7241c4c">FIRST_INFO</a> = MAP_INFO, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a71dc6cbd05a61ca0f3c6d6bfd57b2cf2">MACRO_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05af2f297edecf3ad24764990d325d35f29">META_INFO</a>, 
<br />
&#160;&#160;<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05af8292aef78325420d45fb11f7a0bbf67">TASK_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a7ae389082ea4c263a4df2f3aa3186a8f">ROUTE_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a3b4136d47451943fde3375cdb811c98b">SCHED_TASK_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a6322eef461adaf54bd22c6eda06523b9">SCHED_INFO</a>, 
<br />
&#160;&#160;<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05afab7a58fe818b209b1932ee8d758db27">CAIRN_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a6fda900fe4e3a84219b49c8670377b22">CUSTOM_INFO</a>, 
<a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05a96063b169201f877050e201d280f6404">LAST_INFO</a> = CUSTOM_INFO
<br />
 }<tr class="memdesc:ae8f1a9d7cce478985fc30c9237d93e05"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of the standard Info categories defined for <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps.  <a href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ae8f1a9d7cce478985fc30c9237d93e05"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa2b0edebd71ed20087faf5a9b96e0e01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2b0edebd71ed20087faf5a9b96e0e01"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#aa2b0edebd71ed20087faf5a9b96e0e01">ArMapInfoInterface</a> ()</td></tr>
<tr class="memdesc:aa2b0edebd71ed20087faf5a9b96e0e01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:aa2b0edebd71ed20087faf5a9b96e0e01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a377012af07697ccb5b2d5cbff842d10c"><td class="memItemLeft" align="right" valign="top">virtual std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a377012af07697ccb5b2d5cbff842d10c">getInfo</a> (const char *infoName)=0</td></tr>
<tr class="memdesc:a377012af07697ccb5b2d5cbff842d10c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the arguments for the specified info category; or NULL if none found.  <a href="#a377012af07697ccb5b2d5cbff842d10c">More...</a><br /></td></tr>
<tr class="separator:a377012af07697ccb5b2d5cbff842d10c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25271fd1737e048170dae5e5dc5e841a"><td class="memItemLeft" align="right" valign="top">virtual std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a25271fd1737e048170dae5e5dc5e841a">getInfo</a> (int infoType)=0</td></tr>
<tr class="memdesc:a25271fd1737e048170dae5e5dc5e841a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the strings for the specified Info category.  <a href="#a25271fd1737e048170dae5e5dc5e841a">More...</a><br /></td></tr>
<tr class="separator:a25271fd1737e048170dae5e5dc5e841a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f87bdbc62656d509bdfdc638ebe9af2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f87bdbc62656d509bdfdc638ebe9af2"></a>
virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a4f87bdbc62656d509bdfdc638ebe9af2">getInfoCount</a> () const =0</td></tr>
<tr class="memdesc:a4f87bdbc62656d509bdfdc638ebe9af2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of info categories that are contained in this collection. <br /></td></tr>
<tr class="separator:a4f87bdbc62656d509bdfdc638ebe9af2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ee59537e836bd0e7cde332a6bc46140"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a7ee59537e836bd0e7cde332a6bc46140">getInfoName</a> (int infoType)=0</td></tr>
<tr class="memdesc:a7ee59537e836bd0e7cde332a6bc46140"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the specified Info type.  <a href="#a7ee59537e836bd0e7cde332a6bc46140">More...</a><br /></td></tr>
<tr class="separator:a7ee59537e836bd0e7cde332a6bc46140"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae76435246b06fe6f967f4c2d098cd959"><td class="memItemLeft" align="right" valign="top">virtual std::list&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#ae76435246b06fe6f967f4c2d098cd959">getInfoNames</a> () const =0</td></tr>
<tr class="memdesc:ae76435246b06fe6f967f4c2d098cd959"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a list of the info category names that are contained in this collection.  <a href="#ae76435246b06fe6f967f4c2d098cd959">More...</a><br /></td></tr>
<tr class="separator:ae76435246b06fe6f967f4c2d098cd959"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91d7186534412c603f6f6ac2a9e8d4f7"><td class="memItemLeft" align="right" valign="top">virtual std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a91d7186534412c603f6f6ac2a9e8d4f7">getMapInfo</a> (void)=0</td></tr>
<tr class="memdesc:a91d7186534412c603f6f6ac2a9e8d4f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the map info strings.  <a href="#a91d7186534412c603f6f6ac2a9e8d4f7">More...</a><br /></td></tr>
<tr class="separator:a91d7186534412c603f6f6ac2a9e8d4f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e673838d267f7831d56c7cd7822e32"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#af8e673838d267f7831d56c7cd7822e32">setInfo</a> (const char *infoName, const std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *infoList, <a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *changeDetails=NULL)=0</td></tr>
<tr class="memdesc:af8e673838d267f7831d56c7cd7822e32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the contents of the specified Info category (copies those passed in)  <a href="#af8e673838d267f7831d56c7cd7822e32">More...</a><br /></td></tr>
<tr class="separator:af8e673838d267f7831d56c7cd7822e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe493ef1948a114cbd69b22c8b0043f0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#afe493ef1948a114cbd69b22c8b0043f0">setInfo</a> (int infoType, const std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *infoList, <a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *changeDetails=NULL)=0</td></tr>
<tr class="memdesc:afe493ef1948a114cbd69b22c8b0043f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the contents of the specified Info category (copies those passed in)  <a href="#afe493ef1948a114cbd69b22c8b0043f0">More...</a><br /></td></tr>
<tr class="separator:afe493ef1948a114cbd69b22c8b0043f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04615a60f87e76efc5149c116cdc5119"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a04615a60f87e76efc5149c116cdc5119">setMapInfo</a> (const std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *mapInfo, <a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *changeDetails=NULL)=0</td></tr>
<tr class="memdesc:a04615a60f87e76efc5149c116cdc5119"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the map info (copies those passed in)  <a href="#a04615a60f87e76efc5149c116cdc5119">More...</a><br /></td></tr>
<tr class="separator:a04615a60f87e76efc5149c116cdc5119"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e6f85608759c92ed8079cd047a3ea32"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#a7e6f85608759c92ed8079cd047a3ea32">writeInfoToFunctor</a> (<a class="el" href="classArFunctor1.html">ArFunctor1</a>&lt; const char * &gt; *functor, const char *endOfLineChars)=0</td></tr>
<tr class="memdesc:a7e6f85608759c92ed8079cd047a3ea32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the info collection to a text-based functor.  <a href="#a7e6f85608759c92ed8079cd047a3ea32">More...</a><br /></td></tr>
<tr class="separator:a7e6f85608759c92ed8079cd047a3ea32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9bef84cbe069ec2619d9e80504f2059"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9bef84cbe069ec2619d9e80504f2059"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html#ae9bef84cbe069ec2619d9e80504f2059">~ArMapInfoInterface</a> ()</td></tr>
<tr class="memdesc:ae9bef84cbe069ec2619d9e80504f2059"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ae9bef84cbe069ec2619d9e80504f2059"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aa457e8079e6871cdde8a1faa2140b589"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa457e8079e6871cdde8a1faa2140b589"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>CAIRN_INFO_NAME</b> = &quot;CairnInfo:&quot;</td></tr>
<tr class="separator:aa457e8079e6871cdde8a1faa2140b589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa25010ac54bf3dcc37f52c917e1cd6db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa25010ac54bf3dcc37f52c917e1cd6db"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>CUSTOM_INFO_NAME</b> = &quot;CustomInfo:&quot;</td></tr>
<tr class="separator:aa25010ac54bf3dcc37f52c917e1cd6db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ea055ba6917dedc71dd4fa81fde0a22"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ea055ba6917dedc71dd4fa81fde0a22"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>MACRO_INFO_NAME</b> = &quot;MacroInfo:&quot;</td></tr>
<tr class="separator:a7ea055ba6917dedc71dd4fa81fde0a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e9ecd1f5750dfe1e59f78d8470e5df7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e9ecd1f5750dfe1e59f78d8470e5df7"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>MAP_INFO_NAME</b> = &quot;MapInfo:&quot;</td></tr>
<tr class="separator:a9e9ecd1f5750dfe1e59f78d8470e5df7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a110d07d9f631d0a442f10db8bab6ab25"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a110d07d9f631d0a442f10db8bab6ab25"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>META_INFO_NAME</b> = &quot;MetaInfo:&quot;</td></tr>
<tr class="separator:a110d07d9f631d0a442f10db8bab6ab25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad19fbd8acc0ad17b80989dcc21ce9c77"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad19fbd8acc0ad17b80989dcc21ce9c77"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>ROUTE_INFO_NAME</b> = &quot;RouteInfo:&quot;</td></tr>
<tr class="separator:ad19fbd8acc0ad17b80989dcc21ce9c77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae64bff4e830279cdb33996b21e2e3f0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae64bff4e830279cdb33996b21e2e3f0"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>SCHED_INFO_NAME</b> = &quot;SchedInfo:&quot;</td></tr>
<tr class="separator:aae64bff4e830279cdb33996b21e2e3f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81301565faf511a94e795c021df79758"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a81301565faf511a94e795c021df79758"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>SCHED_TASK_INFO_NAME</b> = &quot;SchedTaskInfo:&quot;</td></tr>
<tr class="separator:a81301565faf511a94e795c021df79758"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7f972070c029ded9a888accda522229"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7f972070c029ded9a888accda522229"></a>
static const char *&#160;</td><td class="memItemRight" valign="bottom"><b>TASK_INFO_NAME</b> = &quot;TaskInfo:&quot;</td></tr>
<tr class="separator:ab7f972070c029ded9a888accda522229"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Methods related to setting and retrieving the various "info" tags in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map. </p>
<p><a class="el" href="classArMapInfoInterface.html" title="Methods related to setting and retrieving the various &quot;info&quot; tags in an Aria map. ...">ArMapInfoInterface</a> is an abstract class that defines the methods used to get and set an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map's "info" arguments. An <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map may have one or more categories of info, each implemented by an ordered list of <a class="el" href="classArArgumentBuilder.html" title="This class is to build arguments for things that require argc and argv. ">ArArgumentBuilder</a>'s. The <a class="el" href="classArMapInfoInterface.html" title="Methods related to setting and retrieving the various &quot;info&quot; tags in an Aria map. ...">ArMapInfoInterface</a> defines access to a collection of these info categories. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a9acc582d92ba2e4748a21c74bd298ac9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b>Deprecated:</b></dt><dd></dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a9acc582d92ba2e4748a21c74bd298ac9a20ee240af44438cad2f33cfe29f21b23"></a>INFO_COUNT&#160;</td><td class="fielddoc">
<p>Number of standard Info categories. </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classArMapInfoInterface.html#ae8f1a9d7cce478985fc30c9237d93e05">ArMapInfoInterface::InfoType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>List of the standard Info categories defined for <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000039">Deprecated:</a></b></dt><dd></dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a34eb25df5af2b80fc9da559b7074b2a7"></a>MAP_INFO&#160;</td><td class="fielddoc">
<p>MapInfo lines that define the valid map object types. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a43cc914ec328dc61f7ad3ac3c7241c4c"></a>FIRST_INFO&#160;</td><td class="fielddoc">
<p>First value in the enumeration. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a71dc6cbd05a61ca0f3c6d6bfd57b2cf2"></a>MACRO_INFO&#160;</td><td class="fielddoc">
<p>MacroInfo lines that contain information about macro templates. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05af2f297edecf3ad24764990d325d35f29"></a>META_INFO&#160;</td><td class="fielddoc">
<p>MetaInfo lines that provide overview info about the map. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05af8292aef78325420d45fb11f7a0bbf67"></a>TASK_INFO&#160;</td><td class="fielddoc">
<p>TaskInfo lines that define the available robot tasks. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a7ae389082ea4c263a4df2f3aa3186a8f"></a>ROUTE_INFO&#160;</td><td class="fielddoc">
<p>RouteInfo lines that are the goal assocs, macros, and routes. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a3b4136d47451943fde3375cdb811c98b"></a>SCHED_TASK_INFO&#160;</td><td class="fielddoc">
<p>SchedTaskInfo that define special tasks that may be scheduled. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a6322eef461adaf54bd22c6eda06523b9"></a>SCHED_INFO&#160;</td><td class="fielddoc">
<p>SchedInfo lines that are the schedules of route patrols. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05afab7a58fe818b209b1932ee8d758db27"></a>CAIRN_INFO&#160;</td><td class="fielddoc">
<p>CairnInfo lines that contain optional arguments for map objects. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a6fda900fe4e3a84219b49c8670377b22"></a>CUSTOM_INFO&#160;</td><td class="fielddoc">
<p>CustomInfo lines contain application specific data. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="ae8f1a9d7cce478985fc30c9237d93e05a96063b169201f877050e201d280f6404"></a>LAST_INFO&#160;</td><td class="fielddoc">
<p>Last value in the enumeration. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a377012af07697ccb5b2d5cbff842d10c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::list&lt;<a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *&gt;* ArMapInfoInterface::getInfo </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>infoName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the arguments for the specified info category; or NULL if none found. </p>
<p>This method returns a pointer to the actual <a class="el" href="classArArgumentBuilder.html" title="This class is to build arguments for things that require argc and argv. ">ArArgumentBuilder</a> list that is contained in the map. It is not safe to store these pointers because they will be deleted when the map is changed. If the caller needs the info arguments at a later time, then it should create its own copy of each argument in the list. This method is not thread-safe.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">infoName</td><td>the unique char * identifier of the info category to be returned; must be non-NULL and a member of </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::list&lt;ArArgumentBuilder *&gt; * a pointer to the specified Info list; NULL if infoType was invalid </dd></dl>

</div>
</div>
<a class="anchor" id="a25271fd1737e048170dae5e5dc5e841a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::list&lt;<a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *&gt;* ArMapInfoInterface::getInfo </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>infoType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the strings for the specified Info category. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000037">Deprecated:</a></b></dt><dd>use <a class="el" href="classArMapInfoInterface.html#a377012af07697ccb5b2d5cbff842d10c" title="Returns the arguments for the specified info category; or NULL if none found. ">getInfo(const char *)</a> instead</dd></dl>
<p>This method returns a pointer to the actual <a class="el" href="classArArgumentBuilder.html" title="This class is to build arguments for things that require argc and argv. ">ArArgumentBuilder</a> list that is contained in the map. It is not safe to store these pointers because they will be deleted when the map is changed. If the caller needs the info arguments at a later time, then it should create its own copy of each argument in the list. This method is not thread-safe.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">infoType</td><td>the int ID of the Info category; must be &gt;= 0 and less than numInfos </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::list&lt;ArArgumentBuilder *&gt; * a pointer to the specified Info list; NULL if infoType was invalid </dd></dl>

</div>
</div>
<a class="anchor" id="a7ee59537e836bd0e7cde332a6bc46140"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* ArMapInfoInterface::getInfoName </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>infoType</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the name of the specified Info type. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000041">Deprecated:</a></b></dt><dd>The info name is the "xInfo:" tag that appears at the beginning of each text line.</dd></dl>
<p>If subclasses define additional Info categories, then they must override this method. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">infoType</td><td>the int ID of the Info category </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>const char * the name of the specified Info category; or NULL if not found </dd></dl>

</div>
</div>
<a class="anchor" id="ae76435246b06fe6f967f4c2d098cd959"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::list&lt;std::string&gt; ArMapInfoInterface::getInfoNames </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns a list of the info category names that are contained in this collection. </p>
<dl class="section return"><dt>Returns</dt><dd>the list of string names of the info categories (for example, MAP_INFO_NAME, META_INFO_NAME, ...) This method is not thread-safe. </dd></dl>

</div>
</div>
<a class="anchor" id="a91d7186534412c603f6f6ac2a9e8d4f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::list&lt;<a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> *&gt;* ArMapInfoInterface::getMapInfo </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the map info strings. </p>
<p>This method is equivalent to getInfo(MAP_INFO_NAME). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classArMapInfoInterface.html#a377012af07697ccb5b2d5cbff842d10c" title="Returns the arguments for the specified info category; or NULL if none found. ">getInfo</a> </dd></dl>

</div>
</div>
<a class="anchor" id="af8e673838d267f7831d56c7cd7822e32"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArMapInfoInterface::setInfo </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>infoName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *&#160;</td>
          <td class="paramname"><em>infoList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *&#160;</td>
          <td class="paramname"><em>changeDetails</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the contents of the specified Info category (copies those passed in) </p>
<p>This method is not thread-safe. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">infoName</td><td>the unique const char * identifier of the </td></tr>
    <tr><td class="paramname">infoList</td><td>the std::list&lt;ArArgumentBuilder *&gt; * that defines the Info category's contents; NULL to clear the Info </td></tr>
    <tr><td class="paramname">changeDetails</td><td>a pointer to the <a class="el" href="classArMapChangeDetails.html" title="Helper class used to track changes to an Aria map. ">ArMapChangeDetails</a> in which to accumulate changes to the map's info lines; if NULL, then changes are not tracked </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool set to true if the contents were successfully set; false, if an error occurred </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classArMapChangeDetails.html" title="Helper class used to track changes to an Aria map. ">ArMapChangeDetails</a> </dd>
<dd>
setInfoNames </dd></dl>

</div>
</div>
<a class="anchor" id="afe493ef1948a114cbd69b22c8b0043f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArMapInfoInterface::setInfo </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>infoType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *&#160;</td>
          <td class="paramname"><em>infoList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *&#160;</td>
          <td class="paramname"><em>changeDetails</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the contents of the specified Info category (copies those passed in) </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000038">Deprecated:</a></b></dt><dd>use <a class="el" href="classArMapInfoInterface.html#af8e673838d267f7831d56c7cd7822e32" title="Sets the contents of the specified Info category (copies those passed in) ">setInfo(const char *,const std::list&lt;ArArgumentBuilder *&gt; *,ArMapChangeDetails*)</a> </dd></dl>
<p>This method is not thread-safe. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">infoType</td><td>the int ID of the Info category to be set </td></tr>
    <tr><td class="paramname">infoList</td><td>the std::list&lt;ArArgumentBuilder *&gt; * that defines the Info category's contents; NULL to clear the Info </td></tr>
    <tr><td class="paramname">changeDetails</td><td>a pointer to the <a class="el" href="classArMapChangeDetails.html" title="Helper class used to track changes to an Aria map. ">ArMapChangeDetails</a> in which to accumulate changes to the map's info lines; if NULL, then changes are not tracked </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool set to true if the contents were successfully set; false, if infoType was invalid </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classArMapChangeDetails.html" title="Helper class used to track changes to an Aria map. ">ArMapChangeDetails</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a04615a60f87e76efc5149c116cdc5119"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ArMapInfoInterface::setMapInfo </td>
          <td>(</td>
          <td class="paramtype">const std::list&lt; <a class="el" href="classArArgumentBuilder.html">ArArgumentBuilder</a> * &gt; *&#160;</td>
          <td class="paramname"><em>mapInfo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classArMapChangeDetails.html">ArMapChangeDetails</a> *&#160;</td>
          <td class="paramname"><em>changeDetails</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Sets the map info (copies those passed in) </p>
<p>This method is equivalent to setInfo(MAP_INFO, mapInfo, changeDetails); </p>

</div>
</div>
<a class="anchor" id="a7e6f85608759c92ed8079cd047a3ea32"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ArMapInfoInterface::writeInfoToFunctor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classArFunctor1.html">ArFunctor1</a>&lt; const char * &gt; *&#160;</td>
          <td class="paramname"><em>functor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>endOfLineChars</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Writes the info collection to a text-based functor. </p>
<p>This method writes a text line for each of the info's ArArgumentBuilders. This method is not thread-safe.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">functor</td><td>a pointer to the <a class="el" href="classArFunctor1.html" title="Base class for functors with 1 parameter. ">ArFunctor1</a> that writes the text lines </td></tr>
    <tr><td class="paramname">endOfLineChars</td><td>the const char * string that indicates the end of each text line </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ArMapInterface_8h.html">ArMapInterface.h</a></li>
<li>ArMapInterface.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArMapInfoInterface.html">ArMapInfoInterface</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
